Transforms forReportBean


ReportToolbarTransform

Formal Parameter Type Default Required Description
appliesTo STRING   false

This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

Possible values for this property are bone ids, its usage depends on the page.
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
cssErrorMessage STRING error-message false

Deprecated. This formal parameter is not referenced anywhere in the code


This is the css name for the error message.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssErrorTitle STRING error-title false

Deprecated. This formal parameter is not referenced anywhere in the code


This is the css name for the error title.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssFile STRING   false CSS file that includes the style definition.
If defined, this file will be included as Link.
cssPrefix STRING   false Prefix to append to all css class names.
cssUseFileContent BOOLEAN false false This is the flag used in the transform to specify whether to show a link to the CSS file or the whole CSS file content.
Allowed Values: TRUE/FALSE.
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
dragMode INTEGER 0 false Indicates the drag mode that the component to render will have.
Usage:
This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include:
  • 1 = can be dragged freely (floating)
  • 2 = can be docked
  • 3 = 1 + 2 (can be dragged freely & docked)
    		•
    extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
    extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
    globalCssErrorMessage STRING error-message false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all error messages.
    globalCssErrorTitle STRING error-title false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all Error titles.
    graphIncrementalFetchStyleForRow STRING ReportStyleIncrementalFetch_1 false This is the name of the style used to show the incremental fetch for row for grid graph reports.
    Allowed Values: any report style name from StyelCatalog.xml file.
    gridAutoStyleBean STRING GridAutoStyle false This is the name of the grid autostyles bean.
    Allowed Values: String values.
    gridGraphIncrementalFetchStyleForRow STRING ReportStyleIncrementalFetch_2 false This is the name of the style used to show the incremental fetch for row for grid graph reports.
    Allowed Values: any report style name from StyelCatalog.xml file.
    gridIncrementalFetchStyleForRow STRING ReportStyleIncrementalFetch_2 false This is the name of the style used to show the incremental fetch for row for grid reports.
    Allowed Values: any report style name from StyelCatalog.xml file.
    height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    iframeEnabled BOOLEAN false false Indicates whether the transform supports iframe manipulations.
    imgCheckOff STRING check_off.gif false This is the image name for check off image used in the transform.
    Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgCheckOn STRING check_on.gif false This is the image name for check on image used in the transform.
    Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgClose STRING close.gif false This is the image name for close image used in the transform.
    Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgError STRING jobError.gif false This is the Image to display when there bean is in Error status.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgGo STRING IconCheck_colored.gif false This is the image name for go image used in the transform.
    Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgWait STRING ani_wait.gif false

    Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


    Name of the image for the Processing icon on the Wait page.
    Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    initialIndent INTEGER 0 false

    Deprecated. Indentation is not appended by Transforms anymore.


    Indicates the initial indentation of the HTML generated.
    orientation INTEGER 2 false Indicates the orientation the dialog to render will have.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = not docked
  • 1 = docked horizontally
  • 2 = docked vertically
    		•
    orientationsAllowed INTEGER 3 false Indicates the orientation modes allowed for the dialog to render.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = no orientations allowed
  • 1 = horizontal orientation allowed
  • 2 = vertical orientation allowed
  • 3 = 1 + 2 (both horiz & vert orientations are allowed)
    		•
    outlineModeDefaultLevelMax BOOLEAN true false If this value is set to true the default level at which any newly run report wil open for outline mode will be maximum expanded.
    If it is false, the default will be fully collapsed.
    This property will be used only if the report property denoting the outline mode level is not present.
    Allowed Values: String values.
    resizeLevel INTEGER 0 false Indicates whether the component can be resized vertically/horizontally or both or none. Possible values are AbstractAppTransform.RESIZE_NONE, AbstractAppTransform.RESIZE_VERTICAL, AbstractAppTransform.RESIZE_HORIZONTAL, AbstractAppTransform.RESIZE_ALL
    scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
    By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
    showOutlineLevelButtons BOOLEAN true false It is used in the transform to specify whether to show the outline mode level buttons.
    Allowed Values: TRUE/FALSE.
    showStyleList BOOLEAN true false This is the flag used in the transform to specify whether to display auto styles list.
    Allowed Values: TRUE/FALSE.
    type STRING   false

    This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

    Possible values for this property are bone ids, its usage depends on the page.
    uniqueReportId STRING UniqueReportID false This is the name of the report's associated bone.
    Allowed Values: String values.
    useBuiltInFormat BOOLEAN true false This is the flag used in the transform to specify whether to use the formatting info from the report definition.
    Out of box, we map the first preference in Grid preferences section to this formal parameter.
    If it's TRUE, WebCSSHelper.getCSS() will give the css class definitions, which is from report formatting defintion.
    If it's FALSE, a specified css file will give the css class definitions, which is what formal paramter cssFile means.
    Allowed Values: TRUE/FALSE.
    useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
    If not set, the bean's OutputFormat() method will be used.
    width STRING   false Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.